Contents

  AvPlay Help Contents

for  Version 4.21 released Friday 13th October 1995

AvPlay and Avalon

AvPlay

Using AvPlay

Command Line

Command Buttons

Compass

Customisation

Menus

Macros and Targeting

Reactions and Triggers

Problems?

Troubleshooting


AvPlay

AvPlay is a specially designed terminal for those who wish to play MUDs across the Internet using Windows. Although specifically developed for use with Avalon, it is intended that players of all types of MUD will find the more basic features of use.

If you have problems using AvPlay, wish to make suggestions for new features or generally want to pass comment, please do so. All correspondence is replied to and gratefully received. Please register this software so that you may be informed of upgrades and  new version releases and where to get them.

AvPlay was written by Dave Austin and is copyright  1995. It is made available free of charge and may be freely distributed, but only in its original zip file format. No warranty is given or implied.


Registration
Registering AvPlay

Please register AvPlay if you use it for any length of time. This costs nothing and simply means that you will be added to an email mailing list so that you can be informed of new versions and upgrades as soon as they become available. Register by sending email to avplay@davros.demon.co.uk,  including the Windows version and version of AvPlay you are using. The AvPlay version is shown in the Help - About menu ; do not rely on the version shown on the Contents for AvPlay Help page, this is there only to show if you have the latest help file or not.

New Versions and upgrades

New versions and upgrades for AvPlay can be found at the Avalon web site at http://www.avalon.co.uk or via anonymous FTP in the /ftp/AvPlay_Windows/ directory at ftp.avalon.co.uk. Unless it is a major new release you will only require an upgrade file which is around a tenth of the size of the full version files. Registered users are informed of which file they require. If you have any problem contacting these sites, send email to avplay@davros.demon.co.uk and I will be pleased to help.

Occasionally, the help file development lags behind the new version releases. When this happens, a separate help file will be released at a later date and registered users duly informed. Check the help contents page and the Help - About screen in AvPlay to see if your versions match.

Comments, suggestions and feedback

ALL feedback is gratefully received and considered. Even the most outlandish suggestions (and there have been a few so far) are added to a list for future consideration. Generally, if enough people request a feature, the request is added to the To do list and will be implemented in a future version, time and technical ability permitting. Send all feedback to avplay@davros.demon.co.uk.

Bug reports

If you find a bug, please report it, but first check the Troubleshooting guide.


Avalon

Avalon is a mythical, virtual world which was first created in late 1989 and is still growing today, shaped and moulded by those who inhabit the land. With thriving social hierarchies, cities and guilds run by the players, a multitude of skills available, blow-by-blow combat, hundreds of quests and a thousand and one sub-plots, it is a living breathing world over which the gods of Mount Olympus watch.

AvPlay features an Interactive option for Avalon players.

Avalon can be contacted across the internet, using Telnet to avalon-rpg.com. Avalon is copyright  to Daniel James and Yehuda Simmons.


Features

AvPlay comprises many features that the experienced MUD player will find invaluable, it also has some features specially designed for the novice. Here is a brief summary of the features incorporated so far.

Scrollback - Split screen scrollback to see what has gone before while missing nothing of what is happening now.

File Capture- Log your sessions on line to file.

Command Line - Separates what you type from the screen. Holds a history of recent commands which can be pulled back and edited.

Macros - Allow regularly used commands or strings of commands to be saved. Also allow for variable targets to be embedded within a macro.

Compass - Use your mouse to traverse the land.

Command Buttons - Use your mouse for quick access to the basic commands.

Reactions - Automatically react to incoming text with a pre-set macro response.

Customisation - Choose your own preferred colours and fonts.

Avalon Interaction - Vital statistics constantly updated for Avalon players.


Command Line
The Command Line

Entering and editing text

.The AvPlay command line is vital for use of MUDs under windows. It separates your text from the rest of the screen and allows easy editing of your commands. To edit what you have typed, move up and down the text using the Left and Right arrows. To jump to the front of the text use the Home key, to the end of the text, the End key. To clear the command line of all current text press Escape or Ctrl+U. You may customise the command line font and colours through the Settings screen.

Command history

The command line saves a history of the last few commands you have typed, allowing quick retrieval of recent commands to be easily repeated. Use the Up and Down arrows to cycle through the command history. Very short commands of two or three characters only are not stored to avoid cluttering your command history.

Pasting to the command line.

The Edit menu allows pasting of text to the command line in the standard Windows fashion. AvPlay allows you to copy text from the screen and paste to the command line.


Command Buttons
The Novices Command Buttons

Left mouse button

Clicking on the command buttons with the left mouse button send the command shown on that button.

Right and middle mouse buttons

Use of the right and middle mouse buttons sends commands associated with that mouse button. These commands tend to be Avalon specific.

Removing from the screen

None novices will have little use for these command buttons, probably preferring to quickly type the commands instead. If this is the case then you can remove the buttons from the display, thus gaining extra screen space. This is done by turning off the Novice Aid in settings.


Compass
The Compass

In low screen resolutions, the compass by default is not loaded to save screen space. The settings screen gives an option to display the compass or not.

Directions

The compass gives mouse control over twelve basic directions : N, NE, E, SE, S, SW, W, NW, In, Out, Up and Down.

Left mouse button

Clicking on the directions with the left mouse button sends the command to move in that direction. Clicking on the centre of the compass sends the EXITS command.

Right and middle mouse buttons

Use of the right mouse button sends the command SQUINT <direction>. Clicking on the centre of the compass sends the command GLANCE. Use of the middle mouse button sends the command to SPRINT <direction>. >. Clicking on the centre of the compass sends the command SURVEY. All the right and middle button compass commands tend to be Avalon specific.


Macros
Macros and Targeting

Editing macro keys

The Edit option on the Macro menu gives you the ability to program a key with a command which can then be retrieved and sent all in one go. Choose Edit from the macro menu then press they key or key combination you wish to program. The key you have chosen will then be displayed and you may enter your macro text. When you have finished press Enter and the macro is stored for that session. You may then enter another macro key or exit using the Cancel button. Use the Macro editing window Edit menu option to copy and paste between macros or from other sources, such as scrollback.

During macro editing, you may use the Left and Right arrows with the Control key to move quickly between separate words within the macro text.

AvPlay allows around 175 macros to be stored. These include the keys F1 to F12, combinations of those keys using Shift+FKey, Ctrl+Fkey and Alt+Fkey (note that some of these keys are reserved for use by Windows). Keys on the numeric keypad may also be programmed with Ctrl and Alt key combinations. All the standard QWERTY keys and numbers may be programmed in combination with Ctrl (Apart from a few short cut keys). In addition some of the punctuation keys may be used for macros, but only in combination with the Ctrl and Alt keys.

Multiple commands on one macro.

AvPlay allows you to enter more than one command in a macro by embedding a carriage return within the macro text. To do this you must use | at the end of each command.. For example :-

Chant healhand|Cast me|Drink sparkling potion|

Pauses in macros.

You may embed a half second pause in your macros using the ~ character. If you use more than one pause the effect will be cumulative. For example :-

Chant fireball|~~Cast north|

would result in the command Chant fireball being sent then one second later the command Cast north would be sent from your AvPlay terminal.

Targets in macros

It is also possible to embed targets in your macros for even greater flexibility. Targets take the form of the $ sign followed by the target number. Here is an example using target 1 :-

Stun $1|get rope from pack|bind $1|

Setting targets

To set targets choose the Targets menu option (Alt+T) and enter the targets name in the appropriate place. You can quickly TAB between target entries. Use the OK button (Alt+O) to exit

AvPlay stores your latest targets and will automatically load them on start-up.

Automatic Triggering Of Macros

It is possible to set macros to trigger automatically by the use of Reactions.


Menu Choices
The Menu Choices

File

Open Log File	Open a capture file

Close Log File	Close a capture file

View Log File	Not yet implemented. Use Notepad to view AvPlay capture files.

Exit	Exit AvPlay

Edit

Copy	Copy text from the screen or scrollback to the Windows clipboard

Paste	Paste to the command line from the Windows clipboard

Connect

Connect	Connect to your MUD

Disconnect	Disconnect from the remote host

Directory	Stores your most recent connection for quick access

Macros

Load	Load an AvPlay macro file (*.avm)

Save	Save the loaded file in its current state

Save As	Save the current file to a new file name

Edit	Edit macro keys

Set As Defaults	Set the current macros as the default for automatic load on start-up

Targets	The target editing screen

Reactions

Active	Toggle reactions active or inactive

Load	Load an AvPlay reaction file ( *.avr )

Save	Save the loaded file in its current state

Save As	Save the current file to a new file name

Edit	Edit reaction texts

Set As Defaults	Set the current reaction set as the default for automatic load on start-up

Scrollback	Open split screen scrollback

Options

Avalon Interactive	Toggle Avalon Interactive mode

Tool Bar	Toggle the tool bar above the screen on and off

Compass Bar	Toggle the compass bar to the right of the screen on and off

Local Echo	Toggle whether or not AvPlay echos your commands.

Settings	The settings screen for personal customisation

Help

Contents	Display this help file

About	AvPlay version information and acknowledgements


File Capture
Capture Files

Opening a capture file

When you choose the Open Log File option from the File menu you are asked to choose a name for the capture file. You may choose a brand new name, click on OK and all screen text will be captured to the log until you close the file using the Close Log File option.

However, it is also possible to choose the name of an existing file that was captured previously. If you choose to do this AvPlay will ask you if you want to replace the existing file and gives you three options as follows :-

Yes	Deletes the existing file and captures to a new file of the same name.

No	Appends newly captured information to the old file

Cancel	Returns you to the file opening dialogue.

Closing a log file

The Close Log File option on the File menu simply closes the open log file and ceases capture.

Viewing a log file

This feature is not yet implemented. Notepad is recommended for viewing AvPlay capture files ( .log)

Automatic file logging

If it is the case that you prefer to capture every session, you may select the Auto Logs option in the Settings screen. This will automatically open a log file and assign it a name which reflects the date. This option does not take immediate effect, but will work from the next, and each subsequent, start-up. If you start-up AvPlay more than once on the same date the existing Auto Log file is appended to.


Connecting

Before attempting to connect, make sure that you are already connected to your provider via Winsock.

Entering your MUDs address

The connect screen allows you to enter the address of your MUD. You must enter the host name, for example avalon-rpg.com . Once you have entered the address and port number (and Winsock is logged in and ready) hit the OK button to connect

Entering a port number

Most MUDs require a port number for connection, be sure you enter the correct one here before attempting to connect. If port number is left blank, AvPlay assumes port number 23, the standard Telnet port number.

Short Cut Connects

The last four addresses connected to are stored on the Connect menu, simply click them once for immediate connection.


Reactions

What is a reaction?

Reactions have two components,  a trigger (a string of text) and an action (commands assigned to a macro). When the trigger text is received, AvPlay will automatically react by sending the command(s) assigned to your action macro. Reactions will only become active through the Active switch on the Reactions menu, Use Ctrl+R as a short cut key to toggle this quickly.

Setting-up reactions

You set up Reactions so that you can automatically react to situations.  To do this, you enter a string of text, (this will be the text that will trigger your reaction) and enter a macro key (the macro assigned to this key will be the action with which you react to the trigger). Please note that trigger text is case sensitive.

Enter the text in the Reaction trigger text box , ending it by hitting the Enter key or Tab, then press the key combination for the macro with which you wish to respond. Then click the Add key to add it to the list of Reactions.

To edit an existing reaction, click on the down arrow to bring up the list of reactions and click on the reaction you wish to edit, this will bring it into the editing box at the top of the list. Complete editing by pressing return and then re-entering the macro key. You must enter a macro key, even if you are using the same key as previously. Once this is done press the add key to add your newly edited reaction to the list. This does not replace the reaction you edited, but adds a new one. Use the Edit menu option in the Reactions Editing window to copy and paste trigger texts. It is recommended that trigger text is copied from scrollback or a log file and pasted into the trigger to ensure that exactly the right string is entered.

To delete a reaction, click on the down arrow to bring up the list of reactions and click on the reaction you wish to delete, then press the delete button to remove the reaction from the list.

Saving reactions

Up to 12 Reactions can be active at any one time. These Reactions can be saved in a .avr file. As many of these reactions files as you wish may be stored. The set of reactions saved in default.avr are loaded automatically each time you start AvPlay.

Warning!

Reactions can be an extremely powerful and flexible tool, but can also cause unpredictable results if not carefully planned out. Define as much text in your trigger as you can to be as sure as possible that you will only react in the situation that you wish to. Never include the same text in your action macro as the trigger text or perform any reaction that results in the same trigger text string being generated as this will cause you to go on reacting infinitely (or at least until something extremely nasty occurs to your incapacitated character).


Scrollback

Using scrollback

This option splits the screen in two allowing you to view what has gone before as well as keeping you in touch with current events. You may use the mouse and the scrollback window scrollbars to view the scrollback text, or the Page Up and Page Down keys to move up and down a page at a time.

Once you open the scrollback window, no more incoming text is added to it. The scrollback contents can be refreshed and brought up to date by closing and opening the window once again. The Alt+S key combination is a quick and easy way to open and close scrollback or if you prefer the Scrollback option on the menu will do the same job using the mouse.

To change the scrollback text size and colours see the Settings menu option


Settings

To display the settings screen, choose settings from the Options menu.

Screen fonts and colours

You have the option to change font and colour attributes for the screen, scrollback window and command line. The font option button allows selection of font to use, its size and colour. All screen fonts available to windows will be an option, but only a few will be suitable, especially where the spacing of text on the screen is concerned.  The background option allows the background colour to be changed. Again not all combinations are suitable as many will leave a ghosting effect. The best advice is to experiment until you find a combination that you like, once chosen AvPlay will save the changes and use them at start-up.

Load defaults

This button restores the original settings for the whole of the settings options.

Option toggles

Auto Log - automatically start a capture file each time AvPlay is started.  See capture files

Novice Aid - toggle the display of the command buttons

Show Compass - toggle the compass display on and off

Echo - Choose to echo your commands to the screen or not.


Avalon Interaction

To toggle this mode, use the Avalon Interaction option on the Options menu once you have connected and logged into Avalon.

This mode is useful to Avalon players only, displaying on screen the vital statistics of health, mana and the rate, if any, at which you are bleeding. This can be very useful in a fast moving and dangerous situation, saving you the need to constantly check your health and mana.


Troubleshooting

Installation	Advice on how best to Install new versions and upgrades.

Reporting Bugs 	How to go about getting some support.

Known Bugs	List of problems known to exist.


Reporting Bugs

First, check that the problem is not in the list of Known Bugs, if it is not, report it by sending email to avplay@davros.demon.co.uk. Bug reports should include:

a) 	any information you can give about the bug, error messages generated, circumstances under 	which it occurs etc etc.

b)	The version of AvPlay you are using (see the Help - About menu)

c)	The Windows version and the Winsock version you are using.

d)	Brief details of your PC and memory (e.g. 386 dx33 with 8Mb RAM)

All bug reports are replied to and usually a fix or workaround can be suggested immediately.


Known Bugs

Error : Not Initialised  - This error tends to occur when AvPlay and your Winsock software have lost contact with each other, usually through one or the other being re-started. If this occurs, close both down and start again, if the error persists, you may have to re-start Windows to clear it. You will also get this error if you attempt to connect using a second copy of AvPlay. In its current state only one copy of AvPlay can be successfully run at one time.

Error : No Data Record Available - If this happens when you are trying to connect, ensure that you have used a named address (e.g. avalon-rpg.com) rather than a numeric IP address (e.g. 204.248.237.2)

Error : Invalid Property Value - AvPlay is trying to use a font your system does not have. If this is the first time you have started AvPlay, copy the file avplay.000 that came in the .zip file to your windows directory, then rename it avplay.ini. Now try running AvPlay again.

Task AVPLAY(####) Did not call WSACleanup. - Reported by Winsock, it means that AvPlay managed to terminate without telling Winsock. No action required.

Windows 95

AvPlay has not yet been properly tested under Windows 95, however it does work adequately. There are some problems with screen-sizing and minor display irregularities have been reported. Later versions of AvPlay will be fully tested and improved for Windows 95.

Windows 95 may install the AvPlay help file other than in the AvPlay directory you have chosen. You should move the help file into the same directory as AvPlay.


Installation

Suggested procedure for installation

1.	Unzip the AvPlay .zip file into a temporary directory.

2.	In Windows, close any applications you have running.

3.	In File Manager, go to the directory with the unzipped files and double click on setup.exe

4	AvPlay will install itself into a directory called Avplay, change this if you wish.

5.	Once installed, go back to File Manger and copy the avplay.hlp file to the AvPlay directory.

Notes:

a) If you receive the message commdlg.dll in use you still have an application running that is clashing with the set-up of AvPlay. Make sure all applications are closed then try again.

b) Set-up may inform you that certain Windows files are to be replaced by later versions, this is because AvPlay uses later updated file than are on your system. You may wish to take a back-up of these files before proceeding.

When you start AvPlay for the first time

If you are having problems, try this procedure :

1.	Close everything and re-start Windows.

2.	Start-up AvPlay. This will also start your Winsock software.

3.	Connect to your internet provider using your Winsock software, logging in as usual.

4.	Now go back to the AvPlay window and attempt to connect.

If your chosen MUD requires a port number, be sure to enter it in the connect screen.

Error: Invalid Property Value - See The Known Bugs section.